Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addition of "lastChecked" Field #145

Conversation

sachinvodafone
Copy link
Collaborator

@sachinvodafone sachinvodafone commented Apr 25, 2024

What type of PR is this?
Add one of the following kinds:

correction

What this PR does / why we need it:
The CAMARA version of the current DeviceStatus API lacks a crucial "lastChecked" field, resulting in inconsistent behavior across vendors. This absence poses challenges for application developers in determining the freshness of roaming status/connectivity data.

Which issue(s) this PR fixes:
Fixes #110

What type of PR is this?
Add one of the following kinds:

correction
What this PR does / why we need it:
The CAMARA version of the current DeviceStatus API lacks a crucial "lastChecked" field, resulting in inconsistent behavior across vendors. This absence poses challenges for application developers in determining the freshness of roaming status/connectivity data.

Which issue(s) this PR fixes:
Fixes camaraproject#110
Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @sachinvodafone
Do you really think that we need to have this attribute mandatory in the response?
I was expecting to have this one as optional. Not a blocker for me.

roaming:
$ref: "#/components/schemas/ActiveRoaming"
countryCode:
$ref: "#/components/schemas/CountryCode"
countryName:
$ref: "#/components/schemas/CountryName"

LastChecked:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me the name is not clear enough, what was checked? Maybe the name should follow the device-status pattern: LastStatusTime

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the field represents the time when the status was last checked, using "checked" instead of "status" would indeed be more appropriate and clearer in conveying the purpose of the field . However, I'm open to updating the field name to either "LastCheckedTime" or "LastStatusTime". I'd like to hear feedback from others on which option the team prefers.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also like "lastStatusTime". It is similar to what has been done in DeviceLocation with "lastLocationTime". https://github.com/camaraproject/DeviceLocation/blob/main/code/API_definitions/location-retrieval.yaml#L239

@fernandopradocabrillo
Copy link
Collaborator

Hi @sachinvodafone Do you really think that we need to have this attribute mandatory in the response? I was expecting to have this one as optional. Not a blocker for me.

Hi, my understanding was the same. I also think that the property should be optional and, in addition to that, the descriptions should be updated accordingly.
By being optional we can define its behaviour as: if the property is not included in the response then the information is fresh. If it is included, it is not.

The desciption of the endpoint specifies:

  • Get the current roaming status and the country information
  • Get the current connectivity status information

Now it may not be the current so the description should reflect that.

@akoshunyadi akoshunyadi added the v0.6.0 Planned for release v0.6.0 label Apr 26, 2024
@sachinvodafone
Copy link
Collaborator Author

Hi @sachinvodafone Do you really think that we need to have this attribute mandatory in the response? I was expecting to have this one as optional. Not a blocker for me.

Noted and will update accordingly

@sachinvodafone sachinvodafone deleted the feature/last-checked-field branch April 26, 2024 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v0.6.0 Planned for release v0.6.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Request for Addition of "last_updated_timestamp" Field in CAMARA DeviceStatus API
4 participants